package com.zmj.common.lock;

import org.redisson.api.RLock;

import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.Lock;

/**
 * @author zmj
 * @date 2021-12-09 15:02
 */
public interface DistributedLock {

    /**
     * 加锁
     *
     * @param lockKey
     * @return
     */
    Lock lock(String lockKey);

    /**
     * 超时时间为s
     *
     * @param lockKey
     * @param timeout s
     * @return
     */
    Lock lock(String lockKey, int timeout);

    /**
     * 可设置超时时间的锁
     *
     * @param lockKey
     * @param unit    时间单位
     * @param timeout 超时时间
     * @return
     */
    Lock lock(String lockKey, TimeUnit unit, int timeout);

    /**
     * 尝试获取锁
     *
     * @param lockKey
     * @param unit      时间单位
     * @param waitTime  最多等待时间
     * @param leaseTime 上锁后自动释放锁时间
     * @return
     */
    boolean tryLock(String lockKey, TimeUnit unit, int waitTime, int leaseTime);

    /**
     * 自动续时锁
     * 默认加锁时间30s ，且每10s给key续期至30s
     *
     * @param lockKey
     * @param unit     时间单位
     * @param waitTime 最多等待时间
     * @return
     */
    boolean tryWatchDogLock(String lockKey, TimeUnit unit, int waitTime);

    /**
     * WatchDog锁
     *
     * @param lockKey
     * @param unit     时间单位
     * @param waitTime 最多等待时间
     * @return Lock 对象
     */
    Lock watchDogLock(String lockKey, TimeUnit unit, int waitTime);

    /**
     * 锁释放
     *
     * @param lockKey
     */
    void unlock(String lockKey);

    /**
     * 锁释放
     *
     * @param lock
     */
    void unlock(RLock lock);
}
